<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Canbot Denayer 13/14 - a: denayer-canbot-13-14-a/src/lowLevel/Serial.h File Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Canbot Denayer 13/14 - a
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="dir_53052291197db0b1569e8461e8a2ce3c.html">denayer-canbot-13-14-a</a>      </li>
      <li class="navelem"><a class="el" href="dir_bbbebf4b0795b632bf706790696c2442.html">src</a>      </li>
      <li class="navelem"><a class="el" href="dir_d149bbdd06eef14263eb86882e8ff83c.html">lowLevel</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Defines</a>  </div>
  <div class="headertitle">
<div class="title">Serial.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Declares the class "Serial", which represents the robot's serial port.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;string&gt;</code><br/>
<code>#include &lt;termios.h&gt;</code><br/>
</div>
<p><a href="Serial_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSerial.html">Serial</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets up the serial connection and exposes it to the program.  <a href="classSerial.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Serial_8h.html#aff330cb4446d20e748d2e4ac2e97c8dc">SERIAL_DEVICE</a>&#160;&#160;&#160;&quot;/dev/ttyUSB0&quot;</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Serial_8h.html#a89f82a9d44beaa52b00c7245a50a105c">SERIAL_BAUDRATE</a>&#160;&#160;&#160;38400</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Serial_8h.html#a2706d6f0b88faa4966405d2d1c792ca6">SERIAL_DATABITS</a>&#160;&#160;&#160;8</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Serial_8h.html#a088517f20a435fda1567860717da4461">SERIAL_PARITY</a>&#160;&#160;&#160;0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Serial_8h.html#a2a7ddb3b4bdf0955971bbf88130c686d">SERIAL_STOPBITS</a>&#160;&#160;&#160;1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Serial_8h.html#a13c5e4e536375e5530a92b4aefa4402c">SERIAL_FLOW_CONTROL</a>&#160;&#160;&#160;0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Serial_8h.html#a6f63eb988b0b1344d3a4a00adca2429b">SERIAL_BUF_LEN</a>&#160;&#160;&#160;1000</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Declares the class "Serial", which represents the robot's serial port. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Beirnaert Simon </dd></dl>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a89f82a9d44beaa52b00c7245a50a105c"></a><!-- doxytag: member="Serial.h::SERIAL_BAUDRATE" ref="a89f82a9d44beaa52b00c7245a50a105c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="Serial_8h.html#a89f82a9d44beaa52b00c7245a50a105c">SERIAL_BAUDRATE</a>&#160;&#160;&#160;38400</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default baudrate </p>

</div>
</div>
<a class="anchor" id="a6f63eb988b0b1344d3a4a00adca2429b"></a><!-- doxytag: member="Serial.h::SERIAL_BUF_LEN" ref="a6f63eb988b0b1344d3a4a00adca2429b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="Serial_8h.html#a6f63eb988b0b1344d3a4a00adca2429b">SERIAL_BUF_LEN</a>&#160;&#160;&#160;1000</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Max number of characters to read at once </p>

</div>
</div>
<a class="anchor" id="a2706d6f0b88faa4966405d2d1c792ca6"></a><!-- doxytag: member="Serial.h::SERIAL_DATABITS" ref="a2706d6f0b88faa4966405d2d1c792ca6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="Serial_8h.html#a2706d6f0b88faa4966405d2d1c792ca6">SERIAL_DATABITS</a>&#160;&#160;&#160;8</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default number of databits </p>

</div>
</div>
<a class="anchor" id="aff330cb4446d20e748d2e4ac2e97c8dc"></a><!-- doxytag: member="Serial.h::SERIAL_DEVICE" ref="aff330cb4446d20e748d2e4ac2e97c8dc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="Serial_8h.html#aff330cb4446d20e748d2e4ac2e97c8dc">SERIAL_DEVICE</a>&#160;&#160;&#160;&quot;/dev/ttyUSB0&quot;</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default serial device </p>

</div>
</div>
<a class="anchor" id="a13c5e4e536375e5530a92b4aefa4402c"></a><!-- doxytag: member="Serial.h::SERIAL_FLOW_CONTROL" ref="a13c5e4e536375e5530a92b4aefa4402c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="Serial_8h.html#a13c5e4e536375e5530a92b4aefa4402c">SERIAL_FLOW_CONTROL</a>&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default setting for flow control </p>

</div>
</div>
<a class="anchor" id="a088517f20a435fda1567860717da4461"></a><!-- doxytag: member="Serial.h::SERIAL_PARITY" ref="a088517f20a435fda1567860717da4461" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="Serial_8h.html#a088517f20a435fda1567860717da4461">SERIAL_PARITY</a>&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default number of parity bits </p>

</div>
</div>
<a class="anchor" id="a2a7ddb3b4bdf0955971bbf88130c686d"></a><!-- doxytag: member="Serial.h::SERIAL_STOPBITS" ref="a2a7ddb3b4bdf0955971bbf88130c686d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="Serial_8h.html#a2a7ddb3b4bdf0955971bbf88130c686d">SERIAL_STOPBITS</a>&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default number of stopbits </p>

</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Thu Apr 24 2014 11:39:28 for Canbot Denayer 13/14 - a by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
